Platform Explorer / Nuxeo Platform 6.0

Operation Collection.CreateCollection (Create a collection)

Description

Create a new collection. This is returning the document serialization of the created collection.
Operation id Collection.CreateCollection
Category Document
Label Create a collection
Requires
Since

Parameters

Name Description Type Required Default value
name string yes  
description string no  

Signature

Inputs void, document
Outputs document, document

Implementation Information

Implementation Class Class: org.nuxeo.ecm.collections.core.automation.CreateCollectionOperation
Contributing Component org.nuxeo.collections.operations

JSON Definition

{
  "id" : "Collection.CreateCollection",
  "label" : "Create a collection",
  "category" : "Document",
  "requires" : null,
  "description" : "Create a new collection. This is returning the document serialization of the created collection.",
  "url" : "Collection.CreateCollection",
  "signature" : [ "void", "document", "document", "document" ],
  "params" : [ {
    "name" : "name",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "description",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}